.\" Man page generated from reStructuredText.
.
.TH "MEMCACHED_ANALYZE" "3" "February 09, 2014" "1.0.18" "libmemcached"
.SH NAME
memcached_analyze \- libmemcached Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
Analyze server information
.SH SYNOPSIS
.sp
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
.B memcached_analysis_st
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%memcached_analysis_st\fP * memcached_analyze(memcached_st\fI\ *ptr\fP, memcached_stat_st\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
\fBlibmemcached\fP has the ability to query a memcached server (or
collection of servers) for their current state. Queries to find state return a
\fI\%memcached_analysis_st\fP structure. You are responsible for freeing this structure.
.sp
\fI\%memcached_analyze()\fP analyzes useful information based on the
provided servers and sets the result to the \fI\%memcached_analysis_st\fP
structure. The return value must be freed by the calling application.
.sp
A command line tool, \fBmemstat\fP with the option \fImemstat \-\-analyze\fP,
is provided so that you do not have to write an application to use this method.
.SH RETURN
.sp
A pointer to the allocated \fI\%memcached_analysis_st\fP structure on
success and a NULL pointer on failure. You may inspect the error detail by
checking the \fBmemcached_return_t\fP value.
.sp
Any method returning a \fI\%memcached_analysis_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011-2013, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.
